草庐IT

PHPDoc 和 __callStatic

全部标签

可变长度参数数组的 PHPDoc

是否有用于记录采用单个配置数组而不是单个参数的函数的语法?我正在特别考虑CodeIgniter风格的库,它们使用与此类似的机制:$value){$this->$key=$value;}}}////Libraryusage:////Iniitializeourconfigurationparameters$config['foo']='test';$config['bar']=4;$config['baz']=array('x','y','z');$x=newMyLibrary($config);?>所以我的问题是,是否有一些受支持的方式来记录配置数组,而不仅仅是纯文本描述?实际指定一个

php/phpDoc - @return $这个类的实例?

如何在我的phpDoc中将方法标记为“返回当前类的实例”?在下面的示例中,我的IDE(Netbeans)将看到setSomething总是返回一个foo对象。但如果我扩展该对象,则情况并非如此-它将返回$this,在第二个示例中是bar对象而不是foo对象。classfoo{protected$_value=null;/***Setsomething**@paramstring$valuethevalue*@returnfoo*/publicfunctionsetSomething($value){$this->_value=$value;return$this;}}$foo=newf

php - PHPdoc @param 中的两种或多种数据类型

好的,我的类方法上面确实有这个phpdoc/***thisafunctionthattranslatesthetext*@paramstring|boolean$langifstringthestringgivenintheparameterwillbethelanguagecodethatwillrepresentthelanguagedesired,iftrue,thiswilltranslatebasedonthewebsite'scurrentlanguage,iffalsewillnottranslate.*/现在我的问题是,如何定义只能接受字符串和bool值的$lang数据

php - 在 phpdoc 中保存函数顺序

我在我的项目上运行phpdoc并且有一个文件(唯一有意义的文件),其中方法的顺序对于分组方法很重要。如何在生成的文档中使用与源文件中相同的函数顺序?实际上,如果有帮助,我准备更改文档框架。 最佳答案 不幸的是,似乎没有办法告诉文档编写者列出方法的顺序。但是,@see可能对您提请注意相关功能很有用。再加上关于所需订单的完整描述中的注释,或者一些无序的异常可能是该工具目前可以提供的最好的。 关于php-在phpdoc中保存函数顺序,我们在StackOverflow上找到一个类似的问题:

PHPdoc - 为 stdClass 对象定义对象属性

我正在尝试弄清楚是否可以使用PHPdoc来定义由函数或对象方法返回的对象属性。假设我有以下类(class):classSomeClass{publicfunctionstaffDetails($id){$object=newstdClass();$object->type="person";$object->name="dave";$object->age="46";return$object;}}现在,很容易定义输入参数。/***GetStaffMemberDetails**@paramstring$idstaffidnumber**@returnobject*/classSomeC

php - PHPDoc 中的闭包语法

我在PHPDoc中找不到任何关于闭包类型的文档。所以我的问题是如何定义发送到闭包的参数的参数及其返回值?例子:我如何描述“回调”将获得一个“MyCustomClass”、一个数字和一个字符串,并返回一个“MyOtherCustomClass”?/***@paramMyCustomClass$cls*@paramClosure$callbackthisisn'treallyexplainingwhatthisis**@returnMyOtherCustomClass*/functionchanger($cls,$callback){return$callback($cls,2,"astr

php - 如何使用 PHPDoc 对 Callable 的参数进行类型提示?

我有一个接受回调作为参数的方法。我想在PHPDoc中为类方法提供一个签名,其中概述了要传递给该方法的回调函数的参数,以便我的IDE(PHPStorm)可以为传递给我的方法的函数生成有效的类型提示,或者至少查看代码的人可以确定他们打算提供的回调的签名。例如:classFoo{public$items=[];/***@paramCallable(*@paramArrayObject$itemsThelistofitemsthatbar()willreturn*)$bazAcallbacktoreceivetheitems**/publicfunctionbar(Callable$baz){

php - 还有什么比 PHPDoc 更好的吗?

关闭。这个问题不符合StackOverflowguidelines.它目前不接受答案。我们不允许提问寻求书籍、工具、软件库等的推荐。您可以编辑问题,以便用事实和引用来回答。关闭7年前。Improvethisquestion除PHPDoc外,还有其他任何东西来记录他们的PHP代码吗?是否有任何工具可以读取相同的文档语法但提供更丰富的输出?

phpDoc 类常量文档

我如何记录phpDoc的类常量?我已阅读手册,但找不到有关它们的任何信息。 最佳答案 常量只需要一个包含描述的文档block。不需要特定的标签。代码解析器本身识别常量并在生成的文档中显示它们(here'sanexample)。 关于phpDoc类常量文档,我们在StackOverflow上找到一个类似的问题: https://stackoverflow.com/questions/3892063/

php - 使用 PHPDoc 显示多行 @param 的正确方法是什么?

根据我所做的研究,我似乎无法找到一种正确的方法来格式化多行phpdoc@param行。推荐的方法是什么?这是一个例子:/***Prints'HelloWorld'.**Printsout'HelloWorld'directlytotheoutput.*CanbeusedtorenderexamplesofPHPDoc.**@paramstring$nounOptional.Sendsagreetingtoagivennouninstead.*Inputisconvertedtolowercaseandcapitalized.*@parambool$surpriseOptional.Ad